<!-- HTML header for doxygen 1.8.14-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Unity ML-Agents Toolkit: UnityAgentsException Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygenbase.css" rel="stylesheet" type="text/css" />
<link href="unity.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Unity ML-Agents Toolkit
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classUnity_1_1MLAgents_1_1UnityAgentsException.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="classUnity_1_1MLAgents_1_1UnityAgentsException-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">UnityAgentsException Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Contains exceptions specific to ML-Agents.  
 <a href="classUnity_1_1MLAgents_1_1UnityAgentsException.html#details">More...</a></p>

<p>Inherits Exception.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:acce20398c37dbe35d46dd408e50e5cbc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1UnityAgentsException.html#acce20398c37dbe35d46dd408e50e5cbc">UnityAgentsException</a> (string message)</td></tr>
<tr class="memdesc:acce20398c37dbe35d46dd408e50e5cbc"><td class="mdescLeft">&#160;</td><td class="mdescRight">When a <a class="el" href="classUnity_1_1MLAgents_1_1UnityAgentsException.html" title="Contains exceptions specific to ML-Agents.">UnityAgentsException</a> is called, the timeScale is set to 0.  <a href="classUnity_1_1MLAgents_1_1UnityAgentsException.html#acce20398c37dbe35d46dd408e50e5cbc">More...</a><br /></td></tr>
<tr class="separator:acce20398c37dbe35d46dd408e50e5cbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a0092d1a70ccdea86ed5a9208e2a3595a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1UnityAgentsException.html#a0092d1a70ccdea86ed5a9208e2a3595a">UnityAgentsException</a> (System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context)</td></tr>
<tr class="memdesc:a0092d1a70ccdea86ed5a9208e2a3595a"><td class="mdescLeft">&#160;</td><td class="mdescRight">A constructor is needed for serialization when an exception propagates from a remoting server to the client.  <a href="classUnity_1_1MLAgents_1_1UnityAgentsException.html#a0092d1a70ccdea86ed5a9208e2a3595a">More...</a><br /></td></tr>
<tr class="separator:a0092d1a70ccdea86ed5a9208e2a3595a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Contains exceptions specific to ML-Agents. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="acce20398c37dbe35d46dd408e50e5cbc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acce20398c37dbe35d46dd408e50e5cbc">&#9670;&nbsp;</a></span>UnityAgentsException() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classUnity_1_1MLAgents_1_1UnityAgentsException.html">UnityAgentsException</a> </td>
          <td>(</td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"><em>message</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>When a <a class="el" href="classUnity_1_1MLAgents_1_1UnityAgentsException.html" title="Contains exceptions specific to ML-Agents.">UnityAgentsException</a> is called, the timeScale is set to 0. </p>
<p>The simulation will end since no steps will be taken.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">message</td><td>The exception message</td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a0092d1a70ccdea86ed5a9208e2a3595a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0092d1a70ccdea86ed5a9208e2a3595a">&#9670;&nbsp;</a></span>UnityAgentsException() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classUnity_1_1MLAgents_1_1UnityAgentsException.html">UnityAgentsException</a> </td>
          <td>(</td>
          <td class="paramtype">System.Runtime.Serialization.SerializationInfo&#160;</td>
          <td class="paramname"><em>info</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">System.Runtime.Serialization.StreamingContext&#160;</td>
          <td class="paramname"><em>context</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>A constructor is needed for serialization when an exception propagates from a remoting server to the client. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">info</td><td>Data for serializing/de-serializing</td></tr>
    <tr><td class="paramname">context</td><td>Describes the source and destination of the serialized stream</td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="UnityAgentsException_8cs.html">UnityAgentsException.cs</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.14-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="namespaceUnity.html">Unity</a></li><li class="navelem"><a class="el" href="namespaceUnity_1_1MLAgents.html">MLAgents</a></li><li class="navelem"><a class="el" href="classUnity_1_1MLAgents_1_1UnityAgentsException.html">UnityAgentsException</a></li>
  </ul>
</div>
</body>
</html>
